home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / share / doc / doc-base / install-docs.html < prev    next >
Encoding:
Extensible Markup Language  |  2009-06-08  |  10.0 KB  |  256 lines
  1. <?xml version="1.0" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <title>install-docs reference</title>
  6. <meta http-equiv="content-type" content="text/html; charset=utf-8" />
  7. <link rev="made" href="mailto:root@localhost" />
  8. </head>
  9.  
  10. <body style="background-color: white">
  11.  
  12.  
  13. <!-- INDEX BEGIN -->
  14. <div name="index">
  15. <p><a name="__index__"></a></p>
  16.  
  17. <ul>
  18.  
  19.     <li><a href="#name">NAME</a></li>
  20.     <li><a href="#synopsis">SYNOPSIS</a></li>
  21.     <li><a href="#description">DESCRIPTION</a></li>
  22.     <li><a href="#options">OPTIONS</a></li>
  23.     <li><a href="#actions">ACTIONS</a></li>
  24.     <li><a href="#compatibility_issues">COMPATIBILITY ISSUES</a></li>
  25.     <li><a href="#files">FILES</a></li>
  26.     <li><a href="#bugs">BUGS</a></li>
  27.     <li><a href="#see_also">SEE ALSO</a></li>
  28.     <li><a href="#author">AUTHOR</a></li>
  29. </ul>
  30.  
  31. <hr name="index" />
  32. </div>
  33. <!-- INDEX END -->
  34.  
  35. <p>
  36. </p>
  37. <h1><a name="name">NAME</a></h1>
  38. <p>install-docs - manage online Debian documentation</p>
  39. <p>
  40. </p>
  41. <hr />
  42. <h1><a name="synopsis">SYNOPSIS</a></h1>
  43. <pre>
  44.  install-docs [options] -i,--install | -r,--remove | -c,--check file [ file ... ]</pre>
  45. <pre>
  46.  install-docs [options] -I,--install-all | -C,--install-changed | -R,--remove-all</pre>
  47. <pre>
  48.  install-docs [options] -s,--status docid [ docid ... ]</pre>
  49. <pre>
  50.  install-docs [options] --dump-db dbname</pre>
  51. <pre>
  52.  install-docs -h,--help | -V,--version</pre>
  53. <p>
  54. </p>
  55. <hr />
  56. <h1><a name="description">DESCRIPTION</a></h1>
  57. <p><strong>install-docs</strong> is a tool allow Debian package maintainers to register
  58. documentation to various documentation systems.  It currently supports
  59. <strong>dhelp</strong>,  <strong>dwww</strong>, <strong>doc-central</strong>, and <strong>scrollkeeper</strong> browsers.</p>
  60. <p>This manual page provides a quick synopsis of <strong>install-docs</strong> usage.
  61. Full documentation can be found in the documentation, including a
  62. description of the control file syntax and grammar.</p>
  63. <p>
  64. </p>
  65. <hr />
  66. <h1><a name="options">OPTIONS</a></h1>
  67. <dl>
  68. <dt><strong><a name="v_verbose" class="item"><strong>-v</strong>, <strong>--verbose</strong></a></strong></dt>
  69.  
  70. <dd>
  71. <p>Operate verbosely.</p>
  72. </dd>
  73. <dt><strong><a name="d_debug" class="item"><strong>-d</strong>, <strong>--debug</strong></a></strong></dt>
  74.  
  75. <dd>
  76. <p>Print some debugging informations.</p>
  77. </dd>
  78. <dt><strong><a name="no_update_menus" class="item"><strong>--no-update-menus</strong></a></strong></dt>
  79.  
  80. <dd>
  81. <p>Inhibit running <em>dwww-build-menu(8)</em>, <em>dhelp_parse(8)</em>,
  82. and <em>scrollkeeper-update(8)</em>.</p>
  83. </dd>
  84. <dt><strong><a name="rootdir_dir" class="item"><strong>--rootdir</strong> <em>dir</em></a></strong></dt>
  85.  
  86. <dd>
  87. <p>Set the root directory to <em>dir</em> instead of `<em>/</em>'. Useful and valid only with
  88. the <strong>--check</strong> action.</p>
  89. </dd>
  90. </dl>
  91. <p>
  92. </p>
  93. <hr />
  94. <h1><a name="actions">ACTIONS</a></h1>
  95. <p>Below is list of possible actions <strong>install-docs</strong> could handle. There can be only one action
  96. option passed to install-docs, moreover the action with its arguments must be the last option
  97. passed.</p>
  98. <p>Each <em>file</em> argument should be the full path for the doc-base control file (i.e.
  99. `/usr/share/doc-base/some_file' or `/etc/doc-base/documents/some_file'), and each
  100. <em>docid</em> should be the document identifier
  101. (Document identifiers are set in the `Document' field of the control file, and usually
  102. correspond to the package name.)</p>
  103. <p>If <em>file</em> or <em>docid</em> equals `<strong>-</strong>' (the minus sign), the list of
  104. arguments is read from the standard input (each file name or document id in separate line).</p>
  105. <dl>
  106. <dt><strong><a name="i_file_file_install_file_file" class="item"><strong>-i</strong> <em>file</em> [<em>file</em> ...],  <strong>--install</strong> <em>file</em> [<em>file</em> ...]</a></strong></dt>
  107.  
  108. <dd>
  109. <p>Install the documentation described by the control file <em>file</em>.</p>
  110. </dd>
  111. <dt><strong><a name="r_file_file_remove_file_file" class="item"><strong>-r</strong> <em>file</em> [<em>file</em> ...],  <strong>--remove</strong> <em>file</em> [<em>file</em> ...]</a></strong></dt>
  112.  
  113. <dd>
  114. <p>Remove the documentation identified by the control file
  115. <em>file</em>.</p>
  116. </dd>
  117. <dt><strong><a name="c_file_file_check_file_file" class="item"><strong>-c</strong> <em>file</em> [<em>file</em> ...],  <strong>--check</strong> <em>file</em> [<em>file</em> ...]</a></strong></dt>
  118.  
  119. <dd>
  120. <p>Check the control file <em>file</em> and display number of possible problems found.
  121. Use with <em>--verbose</em> to get the actual locations of errors and warnings.
  122. If <em>--rootdir</em> was also given, its argument will be prepended to names of the files
  123. given if the `Files' and `Index' fields of the <em>file</em>.</p>
  124. </dd>
  125. <dt><strong><a name="r_remove_all" class="item"><strong>-R</strong>,  <strong>--remove-all</strong></a></strong></dt>
  126.  
  127. <dd>
  128. <p>De-register all registered documents.</p>
  129. </dd>
  130. <dt><strong><a name="i_install_all" class="item"><strong>-I</strong>, <strong>--install-all</strong></a></strong></dt>
  131.  
  132. <dd>
  133. <p>(Re)register all documents from <em class="file">/usr/share/doc-base</em> and <em class="file">/etc/doc-base/documents</em>.</p>
  134. </dd>
  135. <dt><strong><a name="c_install_changed" class="item"><strong>-C</strong>, <strong>--install-changed</strong></a></strong></dt>
  136.  
  137. <dd>
  138. <p>Compare contents of <em class="file">/usr/share/doc-base</em> and <em class="file">/etc/doc-base/documents</em> directories
  139. with registered documents database and de-register any files that are missing and
  140. (re)register only changed or new files.</p>
  141. </dd>
  142. <dt><strong><a name="s_docid_docid_status_docid_docid" class="item"><strong>-s</strong> <em>docid</em> [<em>docid</em> ...], <strong>--status</strong> <em>docid</em> [<em>docid</em> ...]</a></strong></dt>
  143.  
  144. <dd>
  145. <p>Display the status of the document identifier <em>docid</em>.</p>
  146. </dd>
  147. <dt><strong><a name="l_docid_docid_listfiles_docid_docid" class="item"><strong>-L</strong> <em>docid</em> [<em>docid</em> ...], <strong>--listfiles</strong> <em>docid</em> [<em>docid</em> ...]</a></strong></dt>
  148.  
  149. <dd>
  150. <p>Deprecated option. Does nothing.</p>
  151. </dd>
  152. <dt><strong><a name="dump_db_dbname" class="item"><strong>--dump-db</strong> <em>dbname</em></a></strong></dt>
  153.  
  154. <dd>
  155. <p>Dumps contents of internal databases, for debugging purposes. <em>dbname</em> can be either <strong>files.db</strong> or
  156. <strong>status.db</strong>.</p>
  157. </dd>
  158. <dt><strong><a name="h_help" class="item"><strong>-h</strong>, <strong>--help</strong></a></strong></dt>
  159.  
  160. <dd>
  161. <p>Show a short help message.</p>
  162. </dd>
  163. <dt><strong><a name="v_version" class="item"><strong>-V</strong>, <strong>--version</strong></a></strong></dt>
  164.  
  165. <dd>
  166. <p>Display version infromation</p>
  167. </dd>
  168. </dl>
  169. <p>
  170. </p>
  171. <hr />
  172. <h1><a name="compatibility_issues">COMPATIBILITY ISSUES</a></h1>
  173. <p>The following features were added in version 0.8.4,
  174. please make sure to add proper
  175. `<em>Conflicts</em>' or `<em>Depends</em>' lines if you would like to use them in your package's scripts:</p>
  176. <ul>
  177. <li>
  178. <p>support for passing more than one argument to the <strong>-i</strong> and <strong>-r</strong> actions,</p>
  179. </li>
  180. <li>
  181. <p>reading arguments from the standard input,</p>
  182. </li>
  183. <li>
  184. <p><strong>-I</strong>,<strong>--install-all</strong>, <strong>-R</strong>, <strong>---remove-all</strong>, <strong>-c</strong>, <strong>--check</strong> actions,</p>
  185. </li>
  186. <li>
  187. <p><strong>-d</strong>, <strong>--debug</strong>, <strong>-h</strong>, <strong>--help</strong> options.</p>
  188. </li>
  189. </ul>
  190. <pre>
  191.  The B<-C>, B<--install-changed>, B<--dump-db>, B<-V>, B<--version> options were added in 0.8.12.</pre>
  192. <p>
  193. </p>
  194. <hr />
  195. <h1><a name="files">FILES</a></h1>
  196. <dl>
  197. <dt><strong><a name="usr_share_doc_base" class="item"><em class="file">/usr/share/doc-base/</em></a></strong></dt>
  198.  
  199. <dd>
  200. <p>The location of doc-base control files provided by various packages.</p>
  201. </dd>
  202. <dt><strong><a name="etc_doc_base_documents" class="item"><em class="file">/etc/doc-base/documents/</em></a></strong></dt>
  203.  
  204. <dd>
  205. <p>The location of doc-base control files provided by local administrator.</p>
  206. </dd>
  207. <dt><strong><a name="var_lib_doc_base_info_documents" class="item"><em class="file">/var/lib/doc-base/info/documents/</em></a></strong></dt>
  208.  
  209. <dd>
  210. <p>The location of registered control files.</p>
  211. </dd>
  212. <dt><strong><a name="var_lib_doc_base_info_status_db" class="item"><em class="file">/var/lib/doc-base/info/status.db</em></a></strong></dt>
  213.  
  214. <dd>
  215. <p>Statuses of registered documents.</p>
  216. </dd>
  217. <dt><strong><a name="var_lib_doc_base_info_files_db" class="item"><em class="file">/var/lib/doc-base/info/files.db</em></a></strong></dt>
  218.  
  219. <dd>
  220. <p>Timestamps and documents ids of registered doc-base files.</p>
  221. </dd>
  222. <dt><strong><a name="var_lib_doc_base_omf" class="item"><em class="file">/var/lib/doc-base/omf/</em></a></strong></dt>
  223.  
  224. <dd>
  225. <p>The location of generated scrollkeeper OMF files.
  226. Note: <em class="file">/usr/share/omf/doc-base</em> should be a symbolic link pointing to the directory.</p>
  227. </dd>
  228. </dl>
  229. <p>
  230. </p>
  231. <hr />
  232. <h1><a name="bugs">BUGS</a></h1>
  233. <p>See <a href="http://bugs.debian.org/doc-base">http://bugs.debian.org/doc-base</a>.</p>
  234. <p>
  235. </p>
  236. <hr />
  237. <h1><a name="see_also">SEE ALSO</a></h1>
  238. <p><code>dhelp(1)</code>, <code>doccentral(1)</code>, <code>dwww(7)</code>, <code>scrollkeeper(7)</code>,
  239. Debian doc-base Manual <em class="file">/usr/share/doc/doc-base/doc-base.html/index.html</em></p>
  240. <p>
  241. </p>
  242. <hr />
  243. <h1><a name="author">AUTHOR</a></h1>
  244. <p>This program was originally written by Christian Schwarz
  245. <<a href="mailto:schwarz@debian.org">schwarz@debian.org</a>>, for the Debian GNU/Linux system, and the
  246. next maintainer was Adam Di Carlo <<a href="mailto:aph@debian.org">aph@debian.org</a>>.
  247. Robert Luberda <<a href="mailto:robert@debian.org">robert@debian.org</a>> is currently maintaining and extending it.</p>
  248. <p>This software was meant to be for the benefit of the entire Debian
  249. user and developer community.  If you are interested in being involved
  250. with this software, please join the mailing list
  251. <<a href="mailto:debian-doc@lists.debian.org">debian-doc@lists.debian.org</a>>.</p>
  252.  
  253. </body>
  254.  
  255. </html>
  256.